docs: update Java version requirement from 11 to 17#352
docs: update Java version requirement from 11 to 17#352devin-ai-integration[bot] wants to merge 1 commit intomasterfrom
Conversation
Co-Authored-By: shayan@cognition.ai <shayan@cognition.ai>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
| # Getting started | ||
|
|
||
| You'll need Java 11 installed. | ||
| You'll need Java 17 installed. |
There was a problem hiding this comment.
🟡 README claims Java 17 but project still targets Java 11
The README now states "You'll need Java 17 installed" but the actual project configuration still targets Java 11 everywhere:
Root Cause: build.gradle and CI still specify Java 11
In build.gradle:10-11:
sourceCompatibility = '11'
targetCompatibility = '11'
In .github/workflows/gradle.yml:20-24:
- name: Set up JDK 11
uses: actions/setup-java@v4
with:
distribution: zulu
java-version: '11'The README change is misleading — users who only have Java 17 installed may be fine (since Java 17 is backward-compatible with 11), but users who read this and skip Java 11 setup for CI or other tooling will be confused. More importantly, users with only Java 11 installed will now think they can't run the project when they actually can.
Impact: Documentation is now inconsistent with the actual project configuration, potentially causing confusion for contributors and users.
Prompt for agents
Either revert README.md line 47 back to "You'll need Java 11 installed." to match the current build.gradle (sourceCompatibility = '11', targetCompatibility = '11') and CI config (.github/workflows/gradle.yml java-version: '11'), OR update build.gradle lines 10-11 to sourceCompatibility = '17' and targetCompatibility = '17', and update .github/workflows/gradle.yml line 24 to java-version: '17' (and line 20 name to 'Set up JDK 17') so the entire project consistently targets Java 17.
Was this helpful? React with 👍 or 👎 to provide feedback.
Summary
Updates the README to reflect the Java 17 migration by changing the documented Java version requirement from Java 11 to Java 17 in the "Getting started" section.
Review & Testing Checklist for Human
build.gradle/sourceCompatibilityand CI config to confirm the README now matches reality)Notes